home *** CD-ROM | disk | FTP | other *** search
/ Developer CD Series 1998 August: Tool Chest / Dev.CD Aug 98 TC.toast / Sample Code / Networking / OTStreamLogViewer1.0b1 / Internet Config APIs / InternetConfig.p < prev    next >
Encoding:
Text File  |  1997-12-24  |  52.1 KB  |  1,366 lines  |  [TEXT/CWIE]
  1. unit InternetConfig;
  2.  
  3. (* •••Start Header••• *)
  4.  
  5. (* File:         InternetConfig.p
  6.  * Generated by: 1.0d6
  7.  * For:          IC 2.0
  8.  * On:           Wednesday, 24 December 1997, 8:29:16
  9.  * 
  10.  * This file is part of the Internet Configuration system and
  11.  * is placed in the public domain for the benefit of all.
  12.  *)
  13.  
  14. (* •••End Header••• *)
  15.  
  16. interface
  17.  
  18. {$ifc undefined THINK_Pascal}
  19.     uses
  20.         Types,
  21.         Files, 
  22.         QuickDraw, 
  23.         AppleTalk, 
  24.         Aliases, 
  25.         Components;
  26. {$endc}
  27.  
  28. {$PUSH}
  29. {$ALIGN MAC68K}
  30. {$LibExport+}
  31.  
  32.     const
  33.         icPrefNotFoundErr = -666;            (* preference not found (duh!) *)
  34.         icPermErr = -667;                    (* cannot set preference *)
  35.         icPrefDataErr = -668;                (* problem with preference data *)
  36.         icInternalErr = -669;                (* hmm, this is not good *)
  37.         icTruncatedErr = -670;                (* more data was present than was returned *)
  38.         icNoMoreWritersErr = -671;            (* you cannot begin a write session because someone else is already doing it *)
  39.         icNothingToOverrideErr = -672;        (* no component for the override component to capture *)
  40.         icNoURLErr = -673;                    (* no URL found *)
  41.         icConfigNotFoundErr = -674;            (* no configuration was found *)
  42.         icConfigInappropriateErr = -675;    (* incorrect manufacturer code *)
  43.         icProfileNotFoundErr = -676;        (* profile not found *)
  44.         icTooManyProfilesErr = -677;        (* too many profiles in database  *)
  45.  
  46.     const
  47.         ICattr_no_change = -1;                (* supply this to ICSetPref to tell it not to change the attributes *)
  48.  
  49.         ICattr_locked_bit = 0;                (* bits in the preference attributes *)
  50.         ICattr_locked_mask = $00000001;        (* masks for the above *)
  51.         ICattr_volatile_bit = 1;
  52.         ICattr_volatile_mask = $00000002;
  53.  
  54.         icNoUserInteraction_bit = 0;
  55.         icNoUserInteraction_mask = $00000001;
  56.  
  57.         ICfiletype = 'ICAp';
  58.         ICcreator = 'ICAp';
  59.         ICdefault_file_name = 'Internet Preferences';    (* default file name, for internal use, overridden by a component resource *)
  60.     type
  61.         ICDirSpec = record                            (* a record that specifies a folder *)
  62.                 vRefNum: integer;
  63.                 dirID: longint;
  64.             end;
  65.         ICDirSpecArray = array[0..3] of ICDirSpec;    (* an array of the above *)
  66.         ICDirSpecArrayPtr = ^ICDirSpecArray;        (* a pointer to that array *)
  67.         ICAttr = longint;                            (* type for preference attributes *)
  68.         ICError = longint;                            (* type for error codes *)
  69.         ICInstance = Ptr;                            (* opaque type for preference reference *)
  70.         ICPerm = (icNoPerm, icReadOnlyPerm, icReadWritePerm);
  71.         ICConfigRef = record
  72.                 manufacturer: OSType;
  73.                 (* other private data follows *)
  74.             end;
  75.         ICConfigRefPtr = ^ICConfigRef;
  76.         ICConfigRefHandle = ^ICConfigRefPtr;
  77.  
  78.     const
  79.         kICNilProfileID = 0;
  80.     type
  81.         ICProfileID = longint;
  82.         ICProfileIDPtr = ^ICProfileID;
  83.  
  84.     const
  85.         kICEditPreferenceEventClass = 'ICAp';
  86.         kICEditPreferenceEvent = 'ICAp';
  87.         keyICEditPreferenceDestination = 'dest';
  88.  
  89.     const
  90.  
  91. (* •••Start ICKeys.p••• *)
  92.  
  93.         kICRealName = 'RealName';  (* PString -- real name of user *)
  94.         kICEmail = 'Email';  (* PString -- user@host.domain, email address of user, ie return address *)
  95.         kICMailAccount = 'MailAccount';  (* PString -- user@host.domain, account from which to fetch mail *)
  96.         kICMailPassword = 'MailPassword';  (* PString -- scrambled, password for MailAccount *)
  97.         kICNewsAuthUsername = 'NewsAuthUsername';  (* PString -- user name for authorised news servers *)
  98.         kICNewsAuthPassword = 'NewsAuthPassword';  (* PString -- scrambled, password for NewsAuthUsername *)
  99.         kICArchiePreferred = 'ArchiePreferred';  (* PString -- formatted, preferred Archie server *)
  100.         kICArchieAll = 'ArchieAll';  (* STR# -- formatted, list of Archie servers *)
  101.         kICUMichPreferred = 'UMichPreferred';  (* PString -- formatted, preferred UMich server *)
  102.         kICUMichAll = 'UMichAll';  (* STR# -- formatted, list of UMich servers *)
  103.         kICInfoMacPreferred = 'InfoMacPreferred';  (* PString -- formatted, preferred Info-Mac server *)
  104.         kICInfoMacAll = 'InfoMacAll';  (* STR# -- formatted, list of Info-Mac servers *)
  105.         kICPhHost = 'PhHost';  (* PString -- host.domain, default Ph server *)
  106.         kICWhoisHost = 'WhoisHost';  (* PString -- host.domain, default whois server *)
  107.         kICFingerHost = 'FingerHost';  (* PString -- host.domain, default finger server *)
  108.         kICFTPHost = 'FTPHost';  (* PString -- host.domain, default FTP server *)
  109.         kICTelnetHost = 'TelnetHost';  (* PString -- host.domain, default Telnet address *)
  110.         kICSMTPHost = 'SMTPHost';  (* PString -- host.domain, SMTP server *)
  111.         kICNNTPHost = 'NNTPHost';  (* PString -- host.domain, NNTP server *)
  112.         kICGopherHost = 'GopherHost';  (* PString -- host.domain, default Gopher server *)
  113.         kICLDAPServer = 'LDAPServer';  (* PString -- host.domain *)
  114.         kICLDAPSearchbase = 'LDAPSearchbase';  (* PString -- string LDAP thing *)
  115.         kICWWWHomePage = 'WWWHomePage';  (* PString -- URL, users default WWW page *)
  116.         kICWAISGateway = 'WAISGateway';  (* PString -- no idea *)
  117.         kICListFont = 'ListFont';  (* ICFontRecord -- font used for lists of items (eg news article lists) *)
  118.         kICScreenFont = 'ScreenFont';  (* ICFontRecord -- font used for monospaced text (eg news articles) *)
  119.         kICDocumentFont = 'DocumentFont';  (* ICFontRecord -- font used for proportional text *)
  120.         kICPrinterFont = 'PrinterFont';  (* ICFontRecord -- font used to print ScreenFont *)
  121.         kICDownloadFolder = 'DownloadFolder';  (* ICFileSpec -- where to put newly downloaded files *)
  122.         kICSignature = 'Signature';  (* TEXT -- append to news and mail messages *)
  123.         kICOrganization = 'Organization';  (* PString -- for X-Organization string *)
  124.         kICPlan = 'Plan';  (* TEXT -- default response for finger servers *)
  125.         kICQuotingString = 'QuotingString';  (* PString -- used to quote responses in news and mail *)
  126.         kICMailHeaders = 'MailHeaders';  (* TEXT -- extra headers for mail messages *)
  127.         kICNewsHeaders = 'NewsHeaders';  (* TEXT -- extra headers for news messages *)
  128.         kICMapping = 'Mapping';  (* ICMapEntries -- file type mapping, see documentation *)
  129.         kICCharacterSet = 'CharacterSet';  (* ICCharTable -- Mac-to-Net and Net-to-Mac character translation *)
  130.         kICHelper = 'Helper•';  (* ICAppSpec -- helpers for URL schemes *)
  131.         kICServices = 'Services';  (* ICServices -- TCP and IP port-to-name mapping *)
  132.         kICNewMailFlashIcon = 'NewMailFlashIcon';  (* Boolean -- how to announce new mail *)
  133.         kICNewMailDialog = 'NewMailDialog';  (* Boolean *)
  134.         kICNewMailPlaySound = 'NewMailPlaySound';  (* Boolean *)
  135.         kICNewMailSoundName = 'NewMailSoundName';  (* PString *)
  136.         kICWebBackgroundColour = 'WebBackgroundColour';  (* RGBColor -- background colour for web pages *)
  137.         kICNoProxyDomains = 'NoProxyDomains';  (* STR# -- list of domains not to be proxied *)
  138.         kICUseSocks = 'UseSocks';  (* Boolean *)
  139.         kICSocksHost = 'SocksHost';  (* PString -- host.domain, remember that host.domain format allows ":port" and " port" *)
  140.         kICUseHTTPProxy = 'UseHTTPProxy';  (* Boolean *)
  141.         kICHTTPProxyHost = 'HTTPProxyHost';  (* PString -- host.domain *)
  142.         kICUseGopherProxy = 'UseGopherProxy';  (* Boolean *)
  143.         kICGopherProxy = 'GopherProxy';  (* PString -- host.domain, see note in Prog Docs *)
  144.         kICUseFTPProxy = 'UseFTPProxy';  (* Boolean *)
  145.         kICFTPProxyHost = 'FTPProxyHost';  (* PString -- host.domain *)
  146.         kICFTPProxyUser = 'FTPProxyUser';  (* PString -- first level FTP proxy authorisation *)
  147.         kICFTPProxyPassword = 'FTPProxyPassword';  (* PString -- scrambled, password for FTPProxyUser *)
  148.         kICFTPProxyAccount = 'FTPProxyAccount';  (* PString -- second level FTP proxy authorisation *)
  149.         kICUsePassiveFTP = 'UsePassiveFTP';  (* Boolean -- use PASV command for FTP transfers *)
  150.         kICSnailMailAddress = 'SnailMailAddress';  (* TEXT -- preferred mailing address *)
  151.         kICMacSearchHost = 'MacSearchHost';  (* PString -- host for MacSearch queries *)
  152.         kICWebSearchPagePrefs = 'WebSearchPagePrefs';  (* PString -- URL, users default search page *)
  153.         kICWebTextColor = 'WebTextColor';  (* RGBColor -- colour for normal text *)
  154.         kICWebReadColor = '646F6777•WebReadColor';  (* RGBColor -- colour for read links *)
  155.         kICWebUnreadColor = '646F6777•WebUnreadColor';  (* RGBColor -- colour for unread links *)
  156.         kICWebUnderlineLinks = '646F6777•WebUnderlineLinks';  (* Boolean -- whether to underline links *)
  157.         kICNTPHost = 'NTPHost';  (* PString -- host.domain, Network Time Protocol (NTP) *)
  158.  
  159. (* •••End ICKeys.p••• *)
  160.  
  161.     type
  162.         ICFontRecord = record
  163.                 size: integer;
  164.                 face: Style;
  165.                 font: Str255;
  166.             end;
  167.         ICFontRecordPtr = ^ICFontRecord;
  168.         ICFontRecordHandle = ^ICFontRecordPtr;
  169.  
  170.         ICCharTable = record
  171.                 net_to_mac: packed array[char] of char;
  172.                 mac_to_net: packed array[char] of char;
  173.             end;
  174.         ICCharTablePtr = ^ICCharTable;
  175.         ICCharTableHandle = ^ICCharTablePtr;
  176.  
  177.         ICAppSpec = record
  178.                 fCreator: OSType;
  179.                 name: Str63;
  180.             end;
  181.         ICAppSpecPtr = ^ICAppSpec;
  182.         ICAppSpecHandle = ^ICAppSpecPtr;
  183.  
  184. {$ifc OLDROUTINENAMES}
  185.         
  186.         (*    ICFileInfo was originally used to define the format of a key.
  187.             That key was removed, but we forgot to remove ICFileInfo.
  188.             I hope to remove it entirely, but for the moment it's available
  189.             if you define OLDROUTINENAMES.
  190.         *)
  191.         
  192.         ICFileInfo = record
  193.                 fType: OSType;
  194.                 fCreator: OSType;
  195.                 name: Str63;
  196.             end;
  197.         ICFileInfoPtr = ^ICFileInfo;
  198.         ICFileInfoHandle = ^ICFileInfoPtr;
  199. {$endc}
  200.  
  201.         ICFileSpec = record
  202.                 vol_name: Str31;
  203.                 vol_creation_date: longint;
  204.                 fss: FSSpec;                    (* vRefNum field is of no value *)
  205.                 alias: AliasRecord;             (* plus extra data, aliasSize 0 means no alias manager present when ICFileSpecification was created *)
  206.             end;
  207.         ICFileSpecPtr = ^ICFileSpec;
  208.         ICFileSpecHandle = ^ICFileSpecPtr;
  209.     const
  210.         ICfile_spec_header_size = sizeof(ICFileSpec) - sizeof(AliasRecord);
  211.  
  212.     type
  213.         ICMapEntry = record
  214.                 total_length: integer;            (* from beginning of record *)
  215.                 fixed_length: integer;            (* from beginning of record *)
  216.                 version: integer;
  217.                 file_type: OSType;
  218.                 file_creator: OSType;
  219.                 post_creator : OSType;
  220.                 flags: longint;
  221.                 (* variable part starts here *)
  222.                 extension: Str255;                    (* these strings are tightly packed *)
  223.                 creator_app_name: Str255;            (* which means, these ones might have an *)
  224.                 post_app_name : Str255;                (* odd address *)
  225.                 MIME_type: Str255;                    
  226.                 entry_name: Str255;
  227.             end;
  228.         ICMapEntryPtr = ^ICMapEntry;
  229.         ICMapEntryHandle = ^ICMapEntryPtr;
  230.  
  231.     const
  232.         (* bits and masks for the flags of the ICMapEntry *)
  233.         ICmap_binary_bit = 0;                    (* file should be transfered in binary as opposed to text mode *)
  234.         ICmap_binary_mask = $00000001;
  235.         ICmap_resource_fork_bit = 1;            (* the resource fork of the file is significant *)
  236.         ICmap_resource_fork_mask = $00000002;
  237.         ICmap_data_fork_bit = 2;                (* the data fork of the file is significant *)
  238.         ICmap_data_fork_mask = $00000004;
  239.  
  240.         ICmap_post_bit = 3;                        (* post process using post fields *)
  241.         ICmap_post_mask = $00000008;
  242.  
  243.         ICmap_not_incoming_bit = 4;                (* ignore this mapping for incoming files *)
  244.         ICmap_not_incoming_mask = $00000010;
  245.         ICmap_not_outgoing_bit = 5;                (* ignore this mapping for outgoing files *)
  246.         ICmap_not_outgoing_mask = $00000020;
  247.  
  248.         ICmap_fixed_length = 22;                (* number in fixed_length field *)
  249.         
  250.     type
  251.         ICServiceEntry = record
  252.                 name: Str255;                    (* this strings is tightly packed *)
  253.                 port: integer;                    (* which means, these fields might have an *)
  254.                 flags: integer;                    (* odd address *)
  255.             end;
  256.         ICServiceEntryPtr = ^ICServiceEntry;
  257.         ICServiceEntryHandle = ICServiceEntryPtr;
  258.  
  259.         ICServices = record
  260.                 count: integer;
  261.                 services: array[1..1] of ICServiceEntry;    (* this array is packed, so you can't index it directly *)
  262.             end;
  263.         ICServicesPtr = ^ICServices;
  264.         ICServicesHandle = ^ICServicesPtr;
  265.  
  266.     const
  267.         (* bits and masks for the flags of the ICServiceEntry *)
  268.         ICservices_tcp_bit = 0;                    (* this is a TCP service *)
  269.         ICservices_tcp_mask = $00000001;
  270.         ICservices_udp_bit = 1;                    (* this is a UDP service *)
  271.         ICservices_udp_mask = $00000002;
  272.         (* both bits can be set, which means the service is both TCP and UDP, eg daytime *)
  273.  
  274.     (* ***** Notes Relevant To All API Routines ***** *)
  275.  
  276.     (*
  277.         [r1] Requires IC 1.1 or higher.
  278.         [r2] Requires IC 1.2 or higher.
  279.         [r3] Requires IC 2.0 or higher.
  280.         
  281.         [c1] You must have specified a configuration before
  282.              calling this routine.
  283.         [c2] You must have specified the default configuration
  284.              before calling this routine.
  285.         [c3] You do not need to specify a configuration before
  286.              calling this routine.
  287.  
  288.         [b1] You must be inside a Begin/End pair when calling
  289.              this routine.
  290.         [b2] You must be inside a Begin/End read/write pair when
  291.              calling this routine.
  292.         [b3] You do not need to be inside a Begin/End pair when
  293.               calling this routine.
  294.         [b4] If you are getting or setting multiple preferences,
  295.              you should make this call inside a Begin/End pair.
  296.              If you do not make this call inside a Begin/End pair,
  297.              the call will automatically do it for you.
  298.         [b5] It is illegal to call this routine inside a
  299.              Begin/End pair.
  300.     *)
  301.  
  302. (* •••Start ICAPI.p••• *)
  303.  
  304.     (* ***** Starting Up and Shutting Down ***** *)
  305.     
  306.     function ICStart(var inst : ICInstance; creator : OSType) : ICError;
  307.       (* Call this at application initialisation. Set creator to your application
  308.        * creator to allow for future expansion of the IC system. Returns
  309.        * inst as a connection to the IC system.
  310.        *)
  311.     
  312.     function ICStop(inst : ICInstance) : ICError;
  313.       (* [b5] 
  314.        * Call this at application initialisation, after which inst
  315.        * is no longer valid connection to IC.
  316.        *)
  317.     
  318.     (* ***** Specifying a Configuration ***** *)
  319.     
  320.     function ICFindConfigFile(inst : ICInstance; count : integer; folders : ICDirSpecArrayPtr) : ICError;
  321.     {$ifc not GENERATINGCFM}
  322.       inline $2F3C, 6, 2, $7000, $A82A;
  323.     {$endc}
  324.       (* [b5] 
  325.        * Call to configure this connection to IC.
  326.        * Set count as the number of valid elements in folders.
  327.        * Set folders to a pointer to the folders to search.
  328.        * Setting count to 0 and folders to nil is OK.
  329.        * Searches the specified folders and then the Preferences folder
  330.        * in a unspecified manner.
  331.        *)
  332.     
  333.     function ICFindUserConfigFile(inst : ICInstance; var where : ICDirSpec) : ICError;
  334.     {$ifc not GENERATINGCFM}
  335.       inline $2F3C, 4, 14, $7000, $A82A;
  336.     {$endc}
  337.       (* [r1] [b5] 
  338.        * Similar to ICFindConfigFile except that it only searches the folder
  339.        * specified in where.  If the input parameters are valid the routine
  340.        * will always successful configure the instance, creating an
  341.        * empty configuration if necessary
  342.        * For use with double-clickable preference files.
  343.        *)
  344.     
  345.     function ICGeneralFindConfigFile(inst : ICInstance; searchPrefs : Boolean; canCreate : Boolean; count : integer; folders : ICDirSpecArrayPtr) : ICError;
  346.     {$ifc not GENERATINGCFM}
  347.       inline $2F3C, 10, 30, $7000, $A82A;
  348.     {$endc}
  349.       (* [r2] [b5] 
  350.        * Call to configure this connection to IC.
  351.        * This routine acts as a more general replacement for
  352.        * ICFindConfigFile and ICFindUserConfigFile.
  353.        * Set search_prefs to true if you want it to search the preferences folder.
  354.        * Set can_create to true if you want it to be able to create a new config.
  355.        * Set count as the number of valid elements in folders.
  356.        * Set folders to a pointer to the folders to search.
  357.        * Setting count to 0 and folders to nil is OK.
  358.        * Searches the specified folders and then optionally the Preferences folder
  359.        * in a unspecified manner.
  360.        *)
  361.     
  362.     function ICChooseConfig(inst : ICInstance) : ICError;
  363.     {$ifc not GENERATINGCFM}
  364.       inline $2F3C, 0, 33, $7000, $A82A;
  365.     {$endc}
  366.       (* [r2] [b5] 
  367.        * Requests the user to choose a configuration, typically using some
  368.        * sort of modal dialog. If the user cancels the dialog the configuration
  369.        * state will be unaffected.
  370.        *)
  371.     
  372.     function ICChooseNewConfig(inst : ICInstance) : ICError;
  373.     {$ifc not GENERATINGCFM}
  374.       inline $2F3C, 0, 34, $7000, $A82A;
  375.     {$endc}
  376.       (* [r2] [b5] 
  377.        * Requests the user to create a new configuration, typically using some
  378.        * sort of modal dialog. If the user cancels the dialog the configuration
  379.        * state will be unaffected.
  380.        *)
  381.     
  382.     function ICGetConfigName(inst : ICInstance; longname : Boolean; var name : Str255) : ICError;
  383.     {$ifc not GENERATINGCFM}
  384.       inline $2F3C, 6, 35, $7000, $A82A;
  385.     {$endc}
  386.       (* [r2] [c1] [b3] 
  387.        * Returns a string that describes the current configuration at a user
  388.        * level. Set longname to true if you want a long name, up to 255
  389.        * characters, or false if you want a short name, typically about 32
  390.        * characters.
  391.        * The returned string is for user display only. If you rely on the
  392.        * exact format of it, you will conflict with any future IC
  393.        * implementation that doesn't use explicit preference files.
  394.        *)
  395.     
  396.     function ICGetConfigReference(inst : ICInstance; ref : ICConfigRefHandle) : ICError;
  397.     {$ifc not GENERATINGCFM}
  398.       inline $2F3C, 4, 31, $7000, $A82A;
  399.     {$endc}
  400.       (* [r2] [c1] [b3] 
  401.        * Returns a self-contained reference to the instance's current
  402.        * configuration.
  403.        * ref must be a valid non-nil handle and it will be resized to fit the
  404.        * resulting data.
  405.        *)
  406.     
  407.     function ICSetConfigReference(inst : ICInstance; ref : ICConfigRefHandle; flags : longint) : ICError;
  408.     {$ifc not GENERATINGCFM}
  409.       inline $2F3C, 8, 32, $7000, $A82A;
  410.     {$endc}
  411.       (* [r2] [b5] 
  412.        * Reconfigures the instance using a configuration reference that was
  413.        * got using ICGetConfigReference reference. Set the
  414.        * icNoUserInteraction_bit in flags if you require that this routine
  415.        * not present a modal dialog. Other flag bits are reserved and should
  416.        * be set to zero.
  417.        * ref must not be nil.
  418.        *)
  419.     
  420.     (* ***** Private Routines *****
  421.      * 
  422.      * If you are calling these routines, you are most probably doing something
  423.      * wrong.  Please read the documentation for more details.
  424.      *)
  425.     
  426.     function ICSpecifyConfigFile(inst : ICInstance; var config : FSSpec) : ICError;
  427.     {$ifc not GENERATINGCFM}
  428.       inline $2F3C, 4, 3, $7000, $A82A;
  429.     {$endc}
  430.       (* [b5] 
  431.        * For use only by the IC application.
  432.        * If you call this routine yourself, you will conflict with any
  433.        * future IC implementation that doesn't use explicit preference files.
  434.        *)
  435.     
  436.     function ICRefreshCaches(inst : ICInstance) : ICError;
  437.     {$ifc not GENERATINGCFM}
  438.       inline $2F3C, 0, 47, $7000, $A82A;
  439.     {$endc}
  440.       (* [r3] [c1] [b3] 
  441.        * For use only by the IC application.
  442.        * If you call this routine yourself, you will conflict with any
  443.        * future IC implementation that doesn't use explicit preference files.
  444.        *)
  445.     
  446.     (* ***** Getting Information ***** *)
  447.     
  448.     function ICGetSeed(inst : ICInstance; var seed : longint) : ICError;
  449.     {$ifc not GENERATINGCFM}
  450.       inline $2F3C, 4, 4, $7000, $A82A;
  451.     {$endc}
  452.       (* [c3] [b3] 
  453.        * Returns the current seed for the IC prefs database.
  454.        * This seed changes each time a non-volatile preference is changed.
  455.        * You can poll this to determine if any cached preferences change.
  456.        *)
  457.     
  458.     function ICGetPerm(inst : ICInstance; var perm : ICPerm) : ICError;
  459.     {$ifc not GENERATINGCFM}
  460.       inline $2F3C, 4, 13, $7000, $A82A;
  461.     {$endc}
  462.       (* [c3] [b3] 
  463.        * Returns the access permissions currently associated with this instance.
  464.        * While applications normally know what permissions they have,
  465.        * this routine is designed for use by override components.
  466.        *)
  467.     
  468.     function ICDefaultFileName(inst : ICInstance; var name : Str63) : ICError;
  469.     {$ifc not GENERATINGCFM}
  470.       inline $2F3C, 4, 11, $7000, $A82A;
  471.     {$endc}
  472.       (* [c3] [b3] 
  473.        * Returns the default file name for IC preference files.
  474.        * Applications should never need to call this routine.
  475.        * If you rely on information returned by this routine yourself,
  476.        * you may conflict with any future IC implementation that doesn't use
  477.        * explicit preference files.
  478.        * The component calls this routine to set up the default IC file name.
  479.        * This allows this operation to be intercepted by a component that has
  480.        * captured us. It currently gets it from the component resource file.
  481.        * The glue version is hardwired to "Internet Preferences".
  482.        *)
  483.     
  484.     function ICGetComponentInstance(inst : ICInstance; var componentInst : ComponentInstance) : ICError;
  485.       (* [r3] [c3] [b3] 
  486.        * Returns noErr and the connection to the IC component,
  487.        * if we're using the component.
  488.        * Returns badComponenInstance and nil if we're operating with glue.
  489.        *)
  490.     
  491.     (* ***** Reading and Writing Preferences ***** *)
  492.     
  493.     function ICBegin(inst : ICInstance; perm : ICPerm) : ICError;
  494.     {$ifc not GENERATINGCFM}
  495.       inline $2F3C, 2, 5, $7000, $A82A;
  496.     {$endc}
  497.       (* [c1] [b5] 
  498.        * Starting reading or writing multiple preferences.
  499.        * A call to this must be balanced by a call to ICEnd.
  500.        * Do not call WaitNextEvent between these calls.
  501.        * The perm specifies whether you intend to read or read/write.
  502.        * Only one writer is allowed per instance.
  503.        * Note that this may open resource files that are not closed
  504.        * until you call ICEnd.
  505.        *)
  506.     
  507.     function ICGetPref(inst : ICInstance; key : Str255; var attr : ICAttr; buf : Ptr; var size : longint) : ICError;
  508.     {$ifc not GENERATINGCFM}
  509.       inline $2F3C, 16, 6, $7000, $A82A;
  510.     {$endc}
  511.       (* [c1] [b4] 
  512.        * Reads the preference specified by key from the IC database to the
  513.        * buffer pointed to by buf and size.
  514.        * key must not be the empty string.
  515.        * If buf is nil then no data is returned.
  516.        * size must be non-negative.
  517.        * attr and size are always set on return. On errors (except icTruncatedErr)
  518.        * attr is set to ICattr_no_change and size is set to 0.
  519.        * size is the actual size of the data.
  520.        * attr is set to the attributes associated with the preference.
  521.        * If this routine returns icTruncatedErr then the other returned
  522.        * values are valid except that only the first size bytes have been
  523.        * return. size is adjusted to reflect the true size of the preference.
  524.        * Returns icPrefNotFound if there is no preference for the key.
  525.        *)
  526.     
  527.     function ICSetPref(inst : ICInstance; key : Str255; attr : ICAttr; buf : Ptr; size : longint) : ICError;
  528.     {$ifc not GENERATINGCFM}
  529.       inline $2F3C, 16, 7, $7000, $A82A;
  530.     {$endc}
  531.       (* [c1] [b4] 
  532.        * Sets the preference specified by key from the IC database to the
  533.        * value pointed to by buf and size.
  534.        * key must not be the empty string.
  535.        * size must be non-negative. 
  536.        * If buf is nil then the preference value is not set and size is ignored.
  537.        * If buf is not nil then the preference value is set to the size
  538.        * bytes pointed to by buf.
  539.        * If attr is ICattr_no_change then the preference attributes are not set.
  540.        * Otherwise the preference attributes are set to attr.
  541.        * Returns icPermErr if the previous ICBegin was passed icReadOnlyPerm.
  542.        * Returns icPermErr if current attr is locked, new attr is locked and buf <> nil.
  543.        *)
  544.     
  545.     function ICFindPrefHandle(inst : ICInstance; key : Str255; var attr : ICAttr; prefh : Handle) : ICError;
  546.     {$ifc not GENERATINGCFM}
  547.       inline $2F3C, 12, 36, $7000, $A82A;
  548.     {$endc}
  549.       (* [r2] [c1] [b4] 
  550.        * This routine effectively replaces ICGetPrefHandle.
  551.        * Reads the preference specified by key from the IC database into
  552.        * a handle, prefh.
  553.        * key must not be the empty string.
  554.        * attr is set to the attributes associated with the preference.
  555.        * You must set prefh to a non-nil handle before calling this routine.
  556.        * If the preference does not exist, icPrefNotFoundErr is returned.
  557.        *)
  558.     
  559.     function ICGetPrefHandle(inst : ICInstance; key : Str255; var attr : ICAttr; var prefh : Handle) : ICError;
  560.     {$ifc not GENERATINGCFM}
  561.       inline $2F3C, 12, 26, $7000, $A82A;
  562.     {$endc}
  563.       (* [r1] [c1] [b4] 
  564.        * This routine is now obsolete. Use ICFindPrefHandle instead.
  565.        * Reads the preference specified by key from the IC database into
  566.        * a newly created handle, prefh.
  567.        * key must not be the empty string.
  568.        * attr is set to the attributes associated with the preference.
  569.        * The incoming value of prefh is ignored.
  570.        * A new handle is created in the current heap and returned in prefh.
  571.        * If the routine returns an error, prefh is set to nil.
  572.        * If the preference does not exist, no error is returned and prefh is set
  573.        * to an empty handle.
  574.        *)
  575.     
  576.     function ICSetPrefHandle(inst : ICInstance; key : Str255; attr : ICAttr; prefh : Handle) : ICError;
  577.     {$ifc not GENERATINGCFM}
  578.       inline $2F3C, 12, 27, $7000, $A82A;
  579.     {$endc}
  580.       (* [r1] [c1] [b4] 
  581.        * Sets the preference specified by key from the IC database to the
  582.        * value contained in prefh.
  583.        * key must not be the empty string.
  584.        * If prefh is nil then the preference value is not set.
  585.        * If buf is not nil then the preference value is set to the data
  586.        * contained in it.
  587.        * If attr is ICattr_no_change then the preference attributes are not set.
  588.        * Otherwise the preference attributes are set to attr.
  589.        * Returns icPermErr if the previous ICBegin was passed icReadOnlyPerm.
  590.        * Returns icPermErr if current attr is locked, new attr is locked and prefh <> nil.
  591.        *)
  592.     
  593.     function ICCountPref(inst : ICInstance; var count : longint) : ICError;
  594.     {$ifc not GENERATINGCFM}
  595.       inline $2F3C, 4, 8, $7000, $A82A;
  596.     {$endc}
  597.       (* [c1] [b1] 
  598.        * Counts the total number of preferences.
  599.        * If the routine returns an error, count is set to 0.
  600.        *)
  601.     
  602.     function ICGetIndPref(inst : ICInstance; index : longint; var key : Str255) : ICError;
  603.     {$ifc not GENERATINGCFM}
  604.       inline $2F3C, 8, 9, $7000, $A82A;
  605.     {$endc}
  606.       (* [c1] [b1] 
  607.        * Returns the key of the index'th preference.
  608.        * index must be positive.
  609.        * Returns icPrefNotFoundErr if index is greater than the total number of preferences.
  610.        * If the routine returns an error, key is undefined.
  611.        *)
  612.     
  613.     function ICDeletePref(inst : ICInstance; key : Str255) : ICError;
  614.     {$ifc not GENERATINGCFM}
  615.       inline $2F3C, 4, 12, $7000, $A82A;
  616.     {$endc}
  617.       (* [c1] [b2] 
  618.        * Deletes the preference specified by key.
  619.        * key must not be the empty string.
  620.        * Returns icPrefNotFound if the preference specified by key is not present.
  621.        *)
  622.     
  623.     function ICEnd(inst : ICInstance) : ICError;
  624.     {$ifc not GENERATINGCFM}
  625.       inline $2F3C, 0, 10, $7000, $A82A;
  626.     {$endc}
  627.       (* [c1] [b1] 
  628.        * Terminates a preference session, as started by ICBegin.
  629.        * You must have called ICBegin before calling this routine.
  630.        *)
  631.     
  632.     (* ***** User Interface Stuff ***** *)
  633.     
  634.     function ICEditPreferences(inst : ICInstance; key : Str255) : ICError;
  635.     {$ifc not GENERATINGCFM}
  636.       inline $2F3C, 4, 15, $7000, $A82A;
  637.     {$endc}
  638.       (* [r1] [c1] [b3] 
  639.        * Instructs IC to display the user interface associated with editing
  640.        * preferences and focusing on the preference specified by key.
  641.        * If key is the empty string then no preference should be focused upon.
  642.        * You must have specified a configuration before calling this routine.
  643.        * You do not need to call ICBegin before calling this routine.
  644.        * In the current implementation this launches the IC application
  645.        * (or brings it to the front) and displays the window containing
  646.        * the preference specified by key.
  647.        * It may have a radically different implementation in future
  648.        * IC systems.
  649.        *)
  650.     
  651.     (* ***** URL Handling ***** *)
  652.     
  653.     function ICParseURL(inst : ICInstance; hint : Str255; data : Ptr; len : longint; var selStart : longint; var selEnd : longint; url : Handle) : ICError;
  654.     {$ifc not GENERATINGCFM}
  655.       inline $2F3C, 24, 16, $7000, $A82A;
  656.     {$endc}
  657.       (* [r1] [c1] [b3] 
  658.        * Parses a URL out of the specified text and returns it in a canonical form
  659.        * in a handle.
  660.        * hint indicates the default scheme for URLs of the form "name@address".
  661.        * If hint is the empty string then URLs of that form are not allowed.
  662.        * data points to the start of the text. It must not be nil.
  663.        * len indicates the length of the text. It must be non-negative.
  664.        * selStart and selEnd should be passed in as the current selection of
  665.        * the text. This selection is given in the same manner as TextEdit,
  666.        * ie if selStart = selEnd then there is no selection only an insertion
  667.        * point. Also selStart ≤ selEnd and 0 ≤ selStart ≤ len and 0 ≤ selEnd ≤ len.
  668.        * selStart and selEnd are returned as the bounds of the URL. If the
  669.        * routine returns an error then these new boundaries may be
  670.        * invalid but they will be close.
  671.        * The incoming url handle must not be nil.  The resulting URL is normalised
  672.        * and copied into the url handle, which is resized to fit.
  673.        *)
  674.     
  675.     function ICLaunchURL(inst : ICInstance; hint : Str255; data : Ptr; len : longint; var selStart : longint; var selEnd : longint) : ICError;
  676.     {$ifc not GENERATINGCFM}
  677.       inline $2F3C, 20, 17, $7000, $A82A;
  678.     {$endc}
  679.       (* [r1] [c1] [b3] 
  680.        * Parses a URL out of the specified text and feeds it off to the
  681.        * appropriate helper.
  682.        * hint indicates the default scheme for URLs of the form "name@address".
  683.        * If hint is the empty string then URLs of that form are not allowed.
  684.        * data points to the start of the text. It must not be nil.
  685.        * len indicates the length of the text. It must be non-negative.
  686.        * selStart and selEnd should be passed in as the current selection of
  687.        * the text. This selection is given in the same manner as TextEdit,
  688.        * ie if selStart = selEnd then there is no selection only an insertion
  689.        * point. Also selStart ≤ selEnd and 0 ≤ selStart ≤ len and 0 ≤ selEnd ≤ len.
  690.        * selStart and selEnd are returned as the bounds of the URL. If the
  691.        * routine returns an error then these new boundaries may be
  692.        * invalid but they will be close.
  693.        * The URL is parsed out of the text and passed off to the appropriate
  694.        * helper using the GURL AppleEvent.
  695.        *)
  696.     
  697.     (* ***** Mappings Routines *****
  698.      * 
  699.      * Routines for interrogating mappings database.
  700.      * 
  701.      * ----- High Level Routines -----
  702.      *)
  703.     
  704.     function ICMapFilename(inst : ICInstance; filename : Str255; var entry : ICMapEntry) : ICError;
  705.     {$ifc not GENERATINGCFM}
  706.       inline $2F3C, 8, 24, $7000, $A82A;
  707.     {$endc}
  708.       (* [r1] [c1] [b4] 
  709.        * Takes the name of an incoming file and returns the most appropriate
  710.        * mappings database entry, based on its extension.
  711.        * filename must not be the empty string.
  712.        * Returns icPrefNotFoundErr if no suitable entry is found.
  713.        *)
  714.     
  715.     function ICMapTypeCreator(inst : ICInstance; fType : OSType; fCreator : OSType; filename : Str255; var entry : ICMapEntry) : ICError;
  716.     {$ifc not GENERATINGCFM}
  717.       inline $2F3C, 16, 25, $7000, $A82A;
  718.     {$endc}
  719.       (* [r1] [c1] [b4] 
  720.        * Takes the type and creator (and optionally the name) of an outgoing
  721.        * file and returns the most appropriate mappings database entry.
  722.        * The filename may be either the name of the outgoing file or
  723.        * the empty string.
  724.        * Returns icPrefNotFoundErr if no suitable entry found.
  725.        *)
  726.     
  727.     (* ----- Mid Level Routines ----- *)
  728.     
  729.     function ICMapEntriesFilename(inst : ICInstance; entries : Handle; filename : Str255; var entry : ICMapEntry) : ICError;
  730.     {$ifc not GENERATINGCFM}
  731.       inline $2F3C, 12, 28, $7000, $A82A;
  732.     {$endc}
  733.       (* [r1] [c1] [b3] 
  734.        * Takes the name of an incoming file and returns the most appropriate
  735.        * mappings database entry, based on its extension.
  736.        * entries must be a handle to a valid IC mappings database preference.
  737.        * filename must not be the empty string.
  738.        * Returns icPrefNotFoundErr if no suitable entry is found.
  739.        *)
  740.     
  741.     function ICMapEntriesTypeCreator(inst : ICInstance; entries : Handle; fType : OSType; fCreator : OSType; filename : Str255; var entry : ICMapEntry) : ICError;
  742.     {$ifc not GENERATINGCFM}
  743.       inline $2F3C, 20, 29, $7000, $A82A;
  744.     {$endc}
  745.       (* [r1] [c1] [b3] 
  746.        * Takes the type and creator (and optionally the name) of an outgoing
  747.        * file and returns the most appropriate mappings database entry.
  748.        * entries must be a handle to a valid IC mappings database preference.
  749.        * The filename may be either the name of the outgoing file or
  750.        * the empty string.
  751.        * Returns icPrefNotFoundErr if no suitable entry found.
  752.        *)
  753.     
  754.     (* ----- Low Level Routines ----- *)
  755.     
  756.     function ICCountMapEntries(inst : ICInstance; entries : Handle; var count : longint) : ICError;
  757.     {$ifc not GENERATINGCFM}
  758.       inline $2F3C, 8, 18, $7000, $A82A;
  759.     {$endc}
  760.       (* [r1] [c1] [b3] 
  761.        * Counts the number of entries in the mappings database.
  762.        * entries must be a handle to a valid IC mappings database preference.
  763.        * count is set to the number of entries.
  764.        *)
  765.     
  766.     function ICGetIndMapEntry(inst : ICInstance; entries : Handle; index : longint; var pos : longint; var entry : ICMapEntry) : ICError;
  767.     {$ifc not GENERATINGCFM}
  768.       inline $2F3C, 16, 19, $7000, $A82A;
  769.     {$endc}
  770.       (* [r1] [c1] [b3] 
  771.        * Gets the index'th entry in the mappings database.
  772.        * entries must be a handle to a valid IC mappings database preference.
  773.        * index must be in the range from 1 to the number of entries in the database.
  774.        * The value of pos is ignored on input. pos is set to the position of
  775.        * the index'th entry in the database and is suitable for passing back
  776.        * into ICSetMapEntry.
  777.        * Does not return any user data associated with the entry.
  778.        *)
  779.     
  780.     function ICGetMapEntry(inst : ICInstance; entries : Handle; pos : longint; var entry : ICMapEntry) : ICError;
  781.     {$ifc not GENERATINGCFM}
  782.       inline $2F3C, 12, 20, $7000, $A82A;
  783.     {$endc}
  784.       (* [r1] [c1] [b3] 
  785.        * Returns the entry located at position pos in the mappings database.
  786.        * entries must be a handle to a valid IC mappings database preference.
  787.        * pos should be 0 to get the first entry. To get the subsequent entries, add
  788.        * entry.total_size to pos and iterate.
  789.        * Does not return any user data associated with the entry.
  790.        *)
  791.     
  792.     function ICSetMapEntry(inst : ICInstance; entries : Handle; pos : longint; var entry : ICMapEntry) : ICError;
  793.     {$ifc not GENERATINGCFM}
  794.       inline $2F3C, 12, 21, $7000, $A82A;
  795.     {$endc}
  796.       (* [r1] [c1] [b3] 
  797.        * Sets the entry located at position pos in the mappings database.
  798.        * entries must be a handle to a valid IC mappings database preference.
  799.        * pos should be either a value returned from ICGetIndMapEntry or a value
  800.        * calculated using ICGetMapEntry.
  801.        * entry is a var parameter purely for stack space reasons. It is not
  802.        * modified in any way.
  803.        * Any user data associated with the entry is unmodified.
  804.        *)
  805.     
  806.     function ICDeleteMapEntry(inst : ICInstance; entries : Handle; pos : longint) : ICError;
  807.     {$ifc not GENERATINGCFM}
  808.       inline $2F3C, 8, 22, $7000, $A82A;
  809.     {$endc}
  810.       (* [r1] [c1] [b3] 
  811.        * Deletes the mappings database entry at pos.
  812.        * entries must be a handle to a valid IC mappings database preference.
  813.        * pos should be either a value returned from ICGetIndMapEntry or a value
  814.        * calculated using ICGetMapEntry.
  815.        * Also deletes any user data associated with the entry.
  816.        *)
  817.     
  818.     function ICAddMapEntry(inst : ICInstance; entries : Handle; var entry : ICMapEntry) : ICError;
  819.     {$ifc not GENERATINGCFM}
  820.       inline $2F3C, 8, 23, $7000, $A82A;
  821.     {$endc}
  822.       (* [r1] [c1] [b3] 
  823.        * Adds an entry to the mappings database.
  824.        * entries must be a handle to a valid IC mappings database preference.
  825.        * The entry is added to the end of the entries database.
  826.        * No user data is added.
  827.        *)
  828.     
  829.     (* ***** Profile Management Routines ***** *)
  830.     
  831.     function ICGetCurrentProfile(inst : ICInstance; var currentID : ICProfileID) : ICError;
  832.     {$ifc not GENERATINGCFM}
  833.       inline $2F3C, 4, 37, $7000, $A82A;
  834.     {$endc}
  835.       (* [r3] [c1] [b3] 
  836.        * Returns the profile ID of the current profile.
  837.        *)
  838.     
  839.     function ICSetCurrentProfile(inst : ICInstance; newID : ICProfileID) : ICError;
  840.     {$ifc not GENERATINGCFM}
  841.       inline $2F3C, 4, 38, $7000, $A82A;
  842.     {$endc}
  843.       (* [r3] [c1] [b3] 
  844.        * Sets the current profile to the profile specified in newProfile.
  845.        *)
  846.     
  847.     function ICCountProfiles(inst : ICInstance; var count : longint) : ICError;
  848.     {$ifc not GENERATINGCFM}
  849.       inline $2F3C, 4, 39, $7000, $A82A;
  850.     {$endc}
  851.       (* [r3] [c1] [b1] 
  852.        * Returns the total number of profiles.
  853.        *)
  854.     
  855.     function ICGetIndProfile(inst : ICInstance; index : longint; var thisID : ICProfileID) : ICError;
  856.     {$ifc not GENERATINGCFM}
  857.       inline $2F3C, 8, 40, $7000, $A82A;
  858.     {$endc}
  859.       (* [r3] [c1] [b1] 
  860.        * Returns the profile ID of the index'th profile.  index must be positive.
  861.        * Returns icProfileNotFoundErr if index is greater than the total number
  862.        * of profiles.
  863.        *)
  864.     
  865.     function ICGetProfileName(inst : ICInstance; thisID : ICProfileID; var name : Str255) : ICError;
  866.     {$ifc not GENERATINGCFM}
  867.       inline $2F3C, 8, 41, $7000, $A82A;
  868.     {$endc}
  869.       (* [r3] [c1] [b3] 
  870.        * Returns the name of a profile given its ID.  The name may not uniquely
  871.        * identify the profile.  [That's what the profile ID is for!]  The name
  872.        * is assumed to be in the system script.
  873.        *)
  874.     
  875.     function ICSetProfileName(inst : ICInstance; thisID : ICProfileID; name : Str255) : ICError;
  876.     {$ifc not GENERATINGCFM}
  877.       inline $2F3C, 8, 42, $7000, $A82A;
  878.     {$endc}
  879.       (* [r3] [c1] [b3] 
  880.        * This routine sets the name of the specified profile.  Profile names
  881.        * need not be unique.  The name should be in the system script.
  882.        *)
  883.     
  884.     function ICAddProfile(inst : ICInstance; prototypeID : ICProfileID; var newID : ICProfileID) : ICError;
  885.     {$ifc not GENERATINGCFM}
  886.       inline $2F3C, 8, 43, $7000, $A82A;
  887.     {$endc}
  888.       (* [r3] [c1] [b2] 
  889.        * If prototypeID = kICNilProfileID, this routine
  890.        * creates a default profile, otherwise it creates a
  891.        * profile by cloning the prototype profile.  The ID
  892.        * of the new profile is returned in newID.
  893.        * The new profile will be give a new, unique, name.
  894.        * This does not switch to the new profile.
  895.        *)
  896.     
  897.     function ICDeleteProfile(inst : ICInstance; thisID : ICProfileID) : ICError;
  898.     {$ifc not GENERATINGCFM}
  899.       inline $2F3C, 4, 44, $7000, $A82A;
  900.     {$endc}
  901.       (* [r3] [c1] [b2] 
  902.        * This routine deletes the profile specified by
  903.        * thisID.  Attempting to delete the current profile
  904.        * or the last profile will return error.
  905.        *)
  906.     
  907.     (* ***** Interrupt Safe Routines ***** *)
  908.     
  909.     function ICRequiresInterruptSafe(inst : ICInstance) : ICError;
  910.     {$ifc not GENERATINGCFM}
  911.       inline $2F3C, 0, 45, $7000, $A82A;
  912.     {$endc}
  913.       (* [r3] [c2] [b3] 
  914.        * You must call this routine before calling GetMapEntryInterruptSafe
  915.        * to give IC chance to cache the mappings data in memory.  The only
  916.        * way to clear this state is to close the instance.  You can not reconfigure
  917.        * the instance after calling this routine.
  918.        *)
  919.     
  920.     function ICGetMappingInterruptSafe(inst : ICInstance; var mappingPref : Ptr; var mappingPrefSize : longint) : ICError;
  921.     {$ifc not GENERATINGCFM}
  922.       inline $2F3C, 8, 46, $7000, $A82A;
  923.     {$endc}
  924.       (* [r3] [c2] [b3] 
  925.        * Returns the "Mapping" preference in an interrupt safe fashion.
  926.        * The preference returned pointer is valid until the next
  927.        * non-interrupt safe call to IC.  Typically this API is used
  928.        * by software that needs to map extensions to type and creator
  929.        * at interrupt time, eg foreign file systems.
  930.        *)
  931.     
  932.     function ICGetSeedInterruptSafe(inst : ICInstance; var seed : longint) : ICError;
  933.     {$ifc not GENERATINGCFM}
  934.       inline $2F3C, 4, 48, $7000, $A82A;
  935.     {$endc}
  936.       (* [r3] [c2] [b3] 
  937.        * An interrupt safe version of ICGetSeed.
  938.        *)
  939.     
  940.  
  941. (* •••End ICAPI.p••• *)
  942.  
  943.     const
  944.         kICComponentType = 'PREF';                (* the component type *)
  945.         kICComponentSubType = 'ICAp';            (* the component subtype *)
  946.         kICComponentManufacturer = 'JPQE';
  947.         kICComponentInterfaceVersion0 = $00000000;    (* IC >= 1.0 *)
  948.         kICComponentInterfaceVersion1 = $00010000;    (* IC >= 1.1 *)
  949.         kICComponentInterfaceVersion2 = $00020000;    (* IC >= 1.2 *)
  950.         kICComponentInterfaceVersion3 = $00030000;    (* IC >= 2.0 *)
  951.         (* current version number is version 3 *)
  952.         kICComponentInterfaceVersion = kICComponentInterfaceVersion3;
  953.  
  954. {$ifc OLDROUTINENAMES}
  955.  
  956.     (*    This definitions are a) very long, and b) don't conform
  957.         to Mac OS standards for naming constants, so I've put
  958.         them in only if you're using OLDROUTINENAMES.  Please switch
  959.         to the new names given above.
  960.     *)
  961.     const
  962.         internetConfigurationComponentType = 'PREF';                    (* the component type *)
  963.         internetConfigurationComponentSubType = 'ICAp';                    (* the component subtype *)
  964.         internetConfigurationComponentInterfaceVersion0 = $00000000;    (* IC >= 1.0 *)
  965.         internetConfigurationComponentInterfaceVersion1 = $00010000;    (* IC >= 1.1 *)
  966.         internetConfigurationComponentInterfaceVersion2 = $00020000;    (* IC >= 1.2 *)
  967.         internetConfigurationComponentInterfaceVersion3 = $00030000;    (* IC >= 2.0 *)
  968.         (* current version number is version 3 *)
  969.         internetConfigurationComponentInterfaceVersion = internetConfigurationComponentInterfaceVersion3;
  970. {$endc}
  971.  
  972.     const
  973. (* •••Start ICCSelectors.p••• *)
  974.  
  975.         kICCStart = 0;
  976.         kICCStop = 1;
  977.         kICCFindConfigFile = 2;
  978.         kICCFindUserConfigFile = 14;
  979.         kICCGeneralFindConfigFile = 30;
  980.         kICCChooseConfig = 33;
  981.         kICCChooseNewConfig = 34;
  982.         kICCGetConfigName = 35;
  983.         kICCGetConfigReference = 31;
  984.         kICCSetConfigReference = 32;
  985.         kICCSpecifyConfigFile = 3;
  986.         kICCRefreshCaches = 47;
  987.         kICCGetSeed = 4;
  988.         kICCGetPerm = 13;
  989.         kICCDefaultFileName = 11;
  990.         kICCBegin = 5;
  991.         kICCGetPref = 6;
  992.         kICCSetPref = 7;
  993.         kICCFindPrefHandle = 36;
  994.         kICCGetPrefHandle = 26;
  995.         kICCSetPrefHandle = 27;
  996.         kICCCountPref = 8;
  997.         kICCGetIndPref = 9;
  998.         kICCDeletePref = 12;
  999.         kICCEnd = 10;
  1000.         kICCEditPreferences = 15;
  1001.         kICCParseURL = 16;
  1002.         kICCLaunchURL = 17;
  1003.         kICCMapFilename = 24;
  1004.         kICCMapTypeCreator = 25;
  1005.         kICCMapEntriesFilename = 28;
  1006.         kICCMapEntriesTypeCreator = 29;
  1007.         kICCCountMapEntries = 18;
  1008.         kICCGetIndMapEntry = 19;
  1009.         kICCGetMapEntry = 20;
  1010.         kICCSetMapEntry = 21;
  1011.         kICCDeleteMapEntry = 22;
  1012.         kICCAddMapEntry = 23;
  1013.         kICCGetCurrentProfile = 37;
  1014.         kICCSetCurrentProfile = 38;
  1015.         kICCCountProfiles = 39;
  1016.         kICCGetIndProfile = 40;
  1017.         kICCGetProfileName = 41;
  1018.         kICCSetProfileName = 42;
  1019.         kICCAddProfile = 43;
  1020.         kICCDeleteProfile = 44;
  1021.         kICCRequiresInterruptSafe = 45;
  1022.         kICCGetMappingInterruptSafe = 46;
  1023.         kICCGetSeedInterruptSafe = 48;
  1024.     kICCFirstSelector = kICCStart;
  1025.     kICCLastSelector = 48;
  1026.  
  1027. (* •••End ICCSelectors.p••• *)
  1028.  
  1029. (* •••Start ICCAPI.p••• *)
  1030.  
  1031.     (* ***** Starting Up and Shutting Down ***** *)
  1032.     
  1033.     function ICCStart(var inst : ComponentInstance; creator : OSType) : ICError;
  1034.     (* See comment for ICStart. *)
  1035.     
  1036.     function ICCStop(inst : ComponentInstance) : ICError;
  1037.     (* See comment for ICStop. *)
  1038.     
  1039.     (* ***** Specifying a Configuration ***** *)
  1040.     
  1041.     function ICCFindConfigFile(inst : ComponentInstance; count : integer; folders : ICDirSpecArrayPtr) : ICError;
  1042.     {$ifc not GENERATINGCFM}
  1043.       inline $2F3C, 6, 2, $7000, $A82A;
  1044.     {$endc}
  1045.     (* See comment for ICFindConfigFile. *)
  1046.     
  1047.     function ICCFindUserConfigFile(inst : ComponentInstance; var where : ICDirSpec) : ICError;
  1048.     {$ifc not GENERATINGCFM}
  1049.       inline $2F3C, 4, 14, $7000, $A82A;
  1050.     {$endc}
  1051.     (* See comment for ICFindUserConfigFile. *)
  1052.     
  1053.     function ICCGeneralFindConfigFile(inst : ComponentInstance; searchPrefs : Boolean; canCreate : Boolean; count : integer; folders : ICDirSpecArrayPtr) : ICError;
  1054.     {$ifc not GENERATINGCFM}
  1055.       inline $2F3C, 10, 30, $7000, $A82A;
  1056.     {$endc}
  1057.     (* See comment for ICGeneralFindConfigFile. *)
  1058.     
  1059.     function ICCChooseConfig(inst : ComponentInstance) : ICError;
  1060.     {$ifc not GENERATINGCFM}
  1061.       inline $2F3C, 0, 33, $7000, $A82A;
  1062.     {$endc}
  1063.     (* See comment for ICChooseConfig. *)
  1064.     
  1065.     function ICCChooseNewConfig(inst : ComponentInstance) : ICError;
  1066.     {$ifc not GENERATINGCFM}
  1067.       inline $2F3C, 0, 34, $7000, $A82A;
  1068.     {$endc}
  1069.     (* See comment for ICChooseNewConfig. *)
  1070.     
  1071.     function ICCGetConfigName(inst : ComponentInstance; longname : Boolean; var name : Str255) : ICError;
  1072.     {$ifc not GENERATINGCFM}
  1073.       inline $2F3C, 6, 35, $7000, $A82A;
  1074.     {$endc}
  1075.     (* See comment for ICGetConfigName. *)
  1076.     
  1077.     function ICCGetConfigReference(inst : ComponentInstance; ref : ICConfigRefHandle) : ICError;
  1078.     {$ifc not GENERATINGCFM}
  1079.       inline $2F3C, 4, 31, $7000, $A82A;
  1080.     {$endc}
  1081.     (* See comment for ICGetConfigReference. *)
  1082.     
  1083.     function ICCSetConfigReference(inst : ComponentInstance; ref : ICConfigRefHandle; flags : longint) : ICError;
  1084.     {$ifc not GENERATINGCFM}
  1085.       inline $2F3C, 8, 32, $7000, $A82A;
  1086.     {$endc}
  1087.     (* See comment for ICSetConfigReference. *)
  1088.     
  1089.     (* ***** Private Routines *****
  1090.      * 
  1091.      * If you are calling these routines, you are most probably doing something
  1092.      * wrong.  Please read the documentation for more details.
  1093.      *)
  1094.     
  1095.     function ICCSpecifyConfigFile(inst : ComponentInstance; var config : FSSpec) : ICError;
  1096.     {$ifc not GENERATINGCFM}
  1097.       inline $2F3C, 4, 3, $7000, $A82A;
  1098.     {$endc}
  1099.     (* See comment for ICSpecifyConfigFile. *)
  1100.     
  1101.     function ICCRefreshCaches(inst : ComponentInstance) : ICError;
  1102.     {$ifc not GENERATINGCFM}
  1103.       inline $2F3C, 0, 47, $7000, $A82A;
  1104.     {$endc}
  1105.     (* See comment for ICRefreshCaches. *)
  1106.     
  1107.     (* ***** Getting Information ***** *)
  1108.     
  1109.     function ICCGetSeed(inst : ComponentInstance; var seed : longint) : ICError;
  1110.     {$ifc not GENERATINGCFM}
  1111.       inline $2F3C, 4, 4, $7000, $A82A;
  1112.     {$endc}
  1113.     (* See comment for ICGetSeed. *)
  1114.     
  1115.     function ICCGetPerm(inst : ComponentInstance; var perm : ICPerm) : ICError;
  1116.     {$ifc not GENERATINGCFM}
  1117.       inline $2F3C, 4, 13, $7000, $A82A;
  1118.     {$endc}
  1119.     (* See comment for ICGetPerm. *)
  1120.     
  1121.     function ICCDefaultFileName(inst : ComponentInstance; var name : Str63) : ICError;
  1122.     {$ifc not GENERATINGCFM}
  1123.       inline $2F3C, 4, 11, $7000, $A82A;
  1124.     {$endc}
  1125.     (* See comment for ICDefaultFileName. *)
  1126.     
  1127.     function ICCGetComponentInstance(inst : ComponentInstance; var componentInst : ComponentInstance) : ICError;
  1128.     (* See comment for ICGetComponentInstance. *)
  1129.     
  1130.     (* ***** Reading and Writing Preferences ***** *)
  1131.     
  1132.     function ICCBegin(inst : ComponentInstance; perm : ICPerm) : ICError;
  1133.     {$ifc not GENERATINGCFM}
  1134.       inline $2F3C, 2, 5, $7000, $A82A;
  1135.     {$endc}
  1136.     (* See comment for ICBegin. *)
  1137.     
  1138.     function ICCGetPref(inst : ComponentInstance; key : Str255; var attr : ICAttr; buf : Ptr; var size : longint) : ICError;
  1139.     {$ifc not GENERATINGCFM}
  1140.       inline $2F3C, 16, 6, $7000, $A82A;
  1141.     {$endc}
  1142.     (* See comment for ICGetPref. *)
  1143.     
  1144.     function ICCSetPref(inst : ComponentInstance; key : Str255; attr : ICAttr; buf : Ptr; size : longint) : ICError;
  1145.     {$ifc not GENERATINGCFM}
  1146.       inline $2F3C, 16, 7, $7000, $A82A;
  1147.     {$endc}
  1148.     (* See comment for ICSetPref. *)
  1149.     
  1150.     function ICCFindPrefHandle(inst : ComponentInstance; key : Str255; var attr : ICAttr; prefh : Handle) : ICError;
  1151.     {$ifc not GENERATINGCFM}
  1152.       inline $2F3C, 12, 36, $7000, $A82A;
  1153.     {$endc}
  1154.     (* See comment for ICFindPrefHandle. *)
  1155.     
  1156.     function ICCGetPrefHandle(inst : ComponentInstance; key : Str255; var attr : ICAttr; var prefh : Handle) : ICError;
  1157.     {$ifc not GENERATINGCFM}
  1158.       inline $2F3C, 12, 26, $7000, $A82A;
  1159.     {$endc}
  1160.     (* See comment for ICGetPrefHandle. *)
  1161.     
  1162.     function ICCSetPrefHandle(inst : ComponentInstance; key : Str255; attr : ICAttr; prefh : Handle) : ICError;
  1163.     {$ifc not GENERATINGCFM}
  1164.       inline $2F3C, 12, 27, $7000, $A82A;
  1165.     {$endc}
  1166.     (* See comment for ICSetPrefHandle. *)
  1167.     
  1168.     function ICCCountPref(inst : ComponentInstance; var count : longint) : ICError;
  1169.     {$ifc not GENERATINGCFM}
  1170.       inline $2F3C, 4, 8, $7000, $A82A;
  1171.     {$endc}
  1172.     (* See comment for ICCountPref. *)
  1173.     
  1174.     function ICCGetIndPref(inst : ComponentInstance; index : longint; var key : Str255) : ICError;
  1175.     {$ifc not GENERATINGCFM}
  1176.       inline $2F3C, 8, 9, $7000, $A82A;
  1177.     {$endc}
  1178.     (* See comment for ICGetIndPref. *)
  1179.     
  1180.     function ICCDeletePref(inst : ComponentInstance; key : Str255) : ICError;
  1181.     {$ifc not GENERATINGCFM}
  1182.       inline $2F3C, 4, 12, $7000, $A82A;
  1183.     {$endc}
  1184.     (* See comment for ICDeletePref. *)
  1185.     
  1186.     function ICCEnd(inst : ComponentInstance) : ICError;
  1187.     {$ifc not GENERATINGCFM}
  1188.       inline $2F3C, 0, 10, $7000, $A82A;
  1189.     {$endc}
  1190.     (* See comment for ICEnd. *)
  1191.     
  1192.     (* ***** User Interface Stuff ***** *)
  1193.     
  1194.     function ICCEditPreferences(inst : ComponentInstance; key : Str255) : ICError;
  1195.     {$ifc not GENERATINGCFM}
  1196.       inline $2F3C, 4, 15, $7000, $A82A;
  1197.     {$endc}
  1198.     (* See comment for ICEditPreferences. *)
  1199.     
  1200.     (* ***** URL Handling ***** *)
  1201.     
  1202.     function ICCParseURL(inst : ComponentInstance; hint : Str255; data : Ptr; len : longint; var selStart : longint; var selEnd : longint; url : Handle) : ICError;
  1203.     {$ifc not GENERATINGCFM}
  1204.       inline $2F3C, 24, 16, $7000, $A82A;
  1205.     {$endc}
  1206.     (* See comment for ICParseURL. *)
  1207.     
  1208.     function ICCLaunchURL(inst : ComponentInstance; hint : Str255; data : Ptr; len : longint; var selStart : longint; var selEnd : longint) : ICError;
  1209.     {$ifc not GENERATINGCFM}
  1210.       inline $2F3C, 20, 17, $7000, $A82A;
  1211.     {$endc}
  1212.     (* See comment for ICLaunchURL. *)
  1213.     
  1214.     (* ***** Mappings Routines *****
  1215.      * 
  1216.      * Routines for interrogating mappings database.
  1217.      * 
  1218.      * ----- High Level Routines -----
  1219.      *)
  1220.     
  1221.     function ICCMapFilename(inst : ComponentInstance; filename : Str255; var entry : ICMapEntry) : ICError;
  1222.     {$ifc not GENERATINGCFM}
  1223.       inline $2F3C, 8, 24, $7000, $A82A;
  1224.     {$endc}
  1225.     (* See comment for ICMapFilename. *)
  1226.     
  1227.     function ICCMapTypeCreator(inst : ComponentInstance; fType : OSType; fCreator : OSType; filename : Str255; var entry : ICMapEntry) : ICError;
  1228.     {$ifc not GENERATINGCFM}
  1229.       inline $2F3C, 16, 25, $7000, $A82A;
  1230.     {$endc}
  1231.     (* See comment for ICMapTypeCreator. *)
  1232.     
  1233.     (* ----- Mid Level Routines ----- *)
  1234.     
  1235.     function ICCMapEntriesFilename(inst : ComponentInstance; entries : Handle; filename : Str255; var entry : ICMapEntry) : ICError;
  1236.     {$ifc not GENERATINGCFM}
  1237.       inline $2F3C, 12, 28, $7000, $A82A;
  1238.     {$endc}
  1239.     (* See comment for ICMapEntriesFilename. *)
  1240.     
  1241.     function ICCMapEntriesTypeCreator(inst : ComponentInstance; entries : Handle; fType : OSType; fCreator : OSType; filename : Str255; var entry : ICMapEntry) : ICError;
  1242.     {$ifc not GENERATINGCFM}
  1243.       inline $2F3C, 20, 29, $7000, $A82A;
  1244.     {$endc}
  1245.     (* See comment for ICMapEntriesTypeCreator. *)
  1246.     
  1247.     (* ----- Low Level Routines ----- *)
  1248.     
  1249.     function ICCCountMapEntries(inst : ComponentInstance; entries : Handle; var count : longint) : ICError;
  1250.     {$ifc not GENERATINGCFM}
  1251.       inline $2F3C, 8, 18, $7000, $A82A;
  1252.     {$endc}
  1253.     (* See comment for ICCountMapEntries. *)
  1254.     
  1255.     function ICCGetIndMapEntry(inst : ComponentInstance; entries : Handle; index : longint; var pos : longint; var entry : ICMapEntry) : ICError;
  1256.     {$ifc not GENERATINGCFM}
  1257.       inline $2F3C, 16, 19, $7000, $A82A;
  1258.     {$endc}
  1259.     (* See comment for ICGetIndMapEntry. *)
  1260.     
  1261.     function ICCGetMapEntry(inst : ComponentInstance; entries : Handle; pos : longint; var entry : ICMapEntry) : ICError;
  1262.     {$ifc not GENERATINGCFM}
  1263.       inline $2F3C, 12, 20, $7000, $A82A;
  1264.     {$endc}
  1265.     (* See comment for ICGetMapEntry. *)
  1266.     
  1267.     function ICCSetMapEntry(inst : ComponentInstance; entries : Handle; pos : longint; var entry : ICMapEntry) : ICError;
  1268.     {$ifc not GENERATINGCFM}
  1269.       inline $2F3C, 12, 21, $7000, $A82A;
  1270.     {$endc}
  1271.     (* See comment for ICSetMapEntry. *)
  1272.     
  1273.     function ICCDeleteMapEntry(inst : ComponentInstance; entries : Handle; pos : longint) : ICError;
  1274.     {$ifc not GENERATINGCFM}
  1275.       inline $2F3C, 8, 22, $7000, $A82A;
  1276.     {$endc}
  1277.     (* See comment for ICDeleteMapEntry. *)
  1278.     
  1279.     function ICCAddMapEntry(inst : ComponentInstance; entries : Handle; var entry : ICMapEntry) : ICError;
  1280.     {$ifc not GENERATINGCFM}
  1281.       inline $2F3C, 8, 23, $7000, $A82A;
  1282.     {$endc}
  1283.     (* See comment for ICAddMapEntry. *)
  1284.     
  1285.     (* ***** Profile Management Routines ***** *)
  1286.     
  1287.     function ICCGetCurrentProfile(inst : ComponentInstance; var currentID : ICProfileID) : ICError;
  1288.     {$ifc not GENERATINGCFM}
  1289.       inline $2F3C, 4, 37, $7000, $A82A;
  1290.     {$endc}
  1291.     (* See comment for ICGetCurrentProfile. *)
  1292.     
  1293.     function ICCSetCurrentProfile(inst : ComponentInstance; newID : ICProfileID) : ICError;
  1294.     {$ifc not GENERATINGCFM}
  1295.       inline $2F3C, 4, 38, $7000, $A82A;
  1296.     {$endc}
  1297.     (* See comment for ICSetCurrentProfile. *)
  1298.     
  1299.     function ICCCountProfiles(inst : ComponentInstance; var count : longint) : ICError;
  1300.     {$ifc not GENERATINGCFM}
  1301.       inline $2F3C, 4, 39, $7000, $A82A;
  1302.     {$endc}
  1303.     (* See comment for ICCountProfiles. *)
  1304.     
  1305.     function ICCGetIndProfile(inst : ComponentInstance; index : longint; var thisID : ICProfileID) : ICError;
  1306.     {$ifc not GENERATINGCFM}
  1307.       inline $2F3C, 8, 40, $7000, $A82A;
  1308.     {$endc}
  1309.     (* See comment for ICGetIndProfile. *)
  1310.     
  1311.     function ICCGetProfileName(inst : ComponentInstance; thisID : ICProfileID; var name : Str255) : ICError;
  1312.     {$ifc not GENERATINGCFM}
  1313.       inline $2F3C, 8, 41, $7000, $A82A;
  1314.     {$endc}
  1315.     (* See comment for ICGetProfileName. *)
  1316.     
  1317.     function ICCSetProfileName(inst : ComponentInstance; thisID : ICProfileID; name : Str255) : ICError;
  1318.     {$ifc not GENERATINGCFM}
  1319.       inline $2F3C, 8, 42, $7000, $A82A;
  1320.     {$endc}
  1321.     (* See comment for ICSetProfileName. *)
  1322.     
  1323.     function ICCAddProfile(inst : ComponentInstance; prototypeID : ICProfileID; var newID : ICProfileID) : ICError;
  1324.     {$ifc not GENERATINGCFM}
  1325.       inline $2F3C, 8, 43, $7000, $A82A;
  1326.     {$endc}
  1327.     (* See comment for ICAddProfile. *)
  1328.     
  1329.     function ICCDeleteProfile(inst : ComponentInstance; thisID : ICProfileID) : ICError;
  1330.     {$ifc not GENERATINGCFM}
  1331.       inline $2F3C, 4, 44, $7000, $A82A;
  1332.     {$endc}
  1333.     (* See comment for ICDeleteProfile. *)
  1334.     
  1335.     (* ***** Interrupt Safe Routines ***** *)
  1336.     
  1337.     function ICCRequiresInterruptSafe(inst : ComponentInstance) : ICError;
  1338.     {$ifc not GENERATINGCFM}
  1339.       inline $2F3C, 0, 45, $7000, $A82A;
  1340.     {$endc}
  1341.     (* See comment for ICRequiresInterruptSafe. *)
  1342.     
  1343.     function ICCGetMappingInterruptSafe(inst : ComponentInstance; var mappingPref : Ptr; var mappingPrefSize : longint) : ICError;
  1344.     {$ifc not GENERATINGCFM}
  1345.       inline $2F3C, 8, 46, $7000, $A82A;
  1346.     {$endc}
  1347.     (* See comment for ICGetMappingInterruptSafe. *)
  1348.     
  1349.     function ICCGetSeedInterruptSafe(inst : ComponentInstance; var seed : longint) : ICError;
  1350.     {$ifc not GENERATINGCFM}
  1351.       inline $2F3C, 4, 48, $7000, $A82A;
  1352.     {$endc}
  1353.     (* See comment for ICGetSeedInterruptSafe. *)
  1354.     
  1355.  
  1356. (* •••End ICCAPI.p••• *)
  1357.  
  1358. {$ALIGN RESET}
  1359. {$POP}
  1360.  
  1361. {$ifc not undefined THINK_Pascal}
  1362. implementation
  1363. {$endc}
  1364.  
  1365. end. (* InternetConfig *)
  1366.